企业成员密码

一、应用场景

物联云平台提供企业成员忘记密码后的找回功能。企业成员可以通过邮箱或手机号进行重置密码。企业成员通过邮箱或手机号重置密码都需要先在物联云平台管理台配置对应的消息模板。
邮箱重置密码物联云平台提供两种方式，分别为邮件验证码和重置链接的方式进行修改。通过邮件验证码的方式进行修改时，需要企业成员填入接收到的验证码和邮箱账号进行修改。通过重置链接的方式进行修改，需要企业成员点击邮件中的链接，在链接中修改登录密码。
手机重置密码物联云平台提供通过短信验证码的方式进行修改。通过短信验证码的方式进行修改时，需要企业成员填入接收到的验证码和手机号进行修改。

二、功能说明

企业管理员可前往物联云平台管理台【系统设置->组织与用户->用户管理】中修改各个企业成员的登录密码等信息。企业成员可前往物联云平台【账号信息】中修改个人的登录密码。

企业成员通过邮箱重置密码的功能前，需要先前往物联云平台管理台【应用中心->集成->邮件服务】中选择企业使用的邮箱渠道。完成后需要配置【邮件模板->系统推荐->重置密码】和【邮件模板->系统推荐->邮箱找回密码】对应的模板信息。未配置邮件模板的情况下，平台会使用默认的模板发送邮件。

企业成员通过重置链接修改密码前，会在邮箱中接收到物联云平台发送的重置邮件。企业成员需要在重置邮件中点击重置链接进行修改后，使用新密码登入平台中。
企业成员通过邮件验证码修改密码时，会在邮箱中接收到物联云平台发送的找回密码邮件。企业成员需要将邮件中的验证码填入输入框中，和新密码一起提交后，使用新密码登入平台中。

企业成员使用手机号进行重置密码时，会接收到物联云平台发送的重置密码短信。企业成员需要将邮件中的验证码填入输入框中，和新密码一起提交后，使用新密码登入平台中。

三、前提条件

1.企业成员已被创建被已添加邮箱、手机号。
2.完成邮件服务和邮件模板的配置，并保证邮件服务的可用性。
3.完成短信服务和短信模板的配置，并保证短信服务的可用性。
4.企业成员的邮箱或手机可以接收到信息。

四、关键流程

4.1 邮箱找回密码

流程说明：

  • 首先，**B端成员 **在企业管理台输入要找回密码的邮箱后物联网中台发起 根据账号查询企业虚拟信息列表 请求，得到邮箱所在的企业信息列表，并选择要找回密码的企业。
  • 其次，**B端成员 **选择需要找回密码的企业后，向物联网中台发起 通过邮件发送验证码 请求，物联网中台接到请求后向指定的邮箱地址发送修改密码的验证码。
  • 最后，B端成员 接收到修改密码验证码邮件后，查阅得到验证码向物联网中台发起 通过邮件验证码修改密码 请求，物联网中台接到请求进行验证码校验后，将B端成员的密码进行重置。

邮箱找回密码

4.2 手机找回密码

流程说明：

  • 首先，**B端成员 **在企业管理台输入要找回密码的手机号码后物联网中台发起 根据账号查询企业虚拟信息列表 请求，得到手机号码所在的企业信息列表，并选择要找回密码的企业。
  • 其次，**B端成员 **选择需要找回密码的企业后，向物联网中台发起 通过手机发送验证码 请求，物联网中台接到请求后向指定的手机号码发送修改密码的验证码。
  • 最后，B端成员 接收到修改密码验证码短信后，查阅得到验证码向物联网中台发起 通过手机验证码修改密码 请求，物联网中台接到请求进行验证码校验后，将B端成员的密码进行重置。

手机找回密码

五、API列表

5.1 邮箱找回密码

5.1.1 根据账号查询企业虚拟信息列表

接口描述

无凭证下根据邮箱或手机号码查询企业虚拟信息列表，企业名称需要脱敏；企业标识需要虚拟化, 虚拟化标识一小时有效；查询逻辑为根据邮箱或者手机号查询成员列表信息, 然后根据成员所在的企业标识查询所在的企业虚拟信息

请求方式

POST

请求地址

/v2/service/corp-service/members/corp-virtual/infos

请求头

名称 必填 类型 备注
Access-Token true String 调用凭证
企业成员
Content-Type true String application/json

请求参数

名称 位置 必填 类型 备注
email body false String 邮箱地址
phone body false String 手机号码
type body true Int 查询类型
1:邮箱
2:手机号

请求示例：

{
    "type": 1,
    "email": "liqinghua@xlink.cn",
    "phone": "13838383388"
}

返回参数说明

名称 必填 类型 备注
count true Int 符合条件企业总数
list true Array 符合条件企业列表
list.id true String 成员标识
list.name true String 成员名称

返回示例：

{
    "count": 1,
    "list": [{
        "id": "132165654612",
        "name": "物联云平台"
    }]
}

错误码：

错误码 描述
4001001 请求数据字段验证不通过
4001002 请求数据必须字段不可为空
4031001 调用凭证权限被禁止访问
4031003 无效的调用凭证
4031002 需要调用凭证
4041001 接口不存在
5031001 系统错误

5.1.2 通过邮件发送验证码

接口描述

企业成员在忘记密码的情况下，可以通过注册邮箱发送忘记密码专用的验证码，需要选择对应的企业，用于重置密码；成员在收到邮件重置密码后点击链接进入重置密码界面进行重置密码

请求方式

POST

请求地址

/v2/corp/password/forgot/email

请求头

名称 必填 类型 备注
Content-Type true String application/json

请求参数

名称 位置 必填 类型 备注
email body true String 注册人的邮箱地址
corp_id body true String 注册人的企业标识

请求示例：

{
    "email": "liqinghua@xlink.cn",
    "corp_id": "784561346541642334"
}

返回参数说明

名称 必填 类型 备注
无 无 无 无

返回示例：

{
}

错误码：

错误码 描述
4001001 请求数据字段验证不通过
4001002 请求数据必须字段不可为空
4031001 调用凭证权限被禁止访问
4031003 无效的调用凭证
4031002 需要调用凭证
4041001 接口不存在
5031001 系统错误
4031024 权限不足
4041004 邮箱不存在

5.1.3 通过邮件验证码修改密码

接口描述

企业成员在忘记密码的情况下，可以通过注册邮箱发送忘记密码专用的验证码，需要选择对应的企业，用于重置密码；成员在收到邮件重置密码后点击链接进入重置密码界面进行重置密码

请求方式

POST

请求地址

/v2/corp/password/reset/email

请求头

名称 必填 类型 备注
Content-Type true String application/json

请求参数

名称 位置 必填 类型 备注
email body true String 注册人的邮箱地址
verifycode body true String 邮件验证码
password body true String 注册人的新密码

请求示例：

{
    "email": "liqinghua@xlink.cn",
    "verifycode":"513123",
    "password":"Test@#$fsdfwrw"
}

返回参数说明

名称 必填 类型 备注
无 无 无 无

返回示例：

{
}

错误码：

错误码 描述
4001001 请求数据字段验证不通过
4001002 请求数据必须字段不可为空
4031001 调用凭证权限被禁止访问
4031003 无效的调用凭证
4031002 需要调用凭证
4041001 接口不存在
5031001 系统错误
4041004 邮箱不存在
4041003 成员不存在
4001009 成员状态不合法

5.2 手机找回密码

5.2.1 根据账号查询企业虚拟信息列表

接口描述

无凭证下根据邮箱或手机号码查询企业虚拟信息列表，企业名称需要脱敏；企业标识需要虚拟化, 虚拟化标识一小时有效；查询逻辑为根据邮箱或者手机号查询成员列表信息, 然后根据成员所在的企业标识查询所在的企业虚拟信息

请求方式

POST

请求地址

/v2/service/corp-service/members/corp-virtual/infos

请求头

名称 必填 类型 备注
Access-Token true String 调用凭证
企业成员
Content-Type true String application/json

请求参数

名称 位置 必填 类型 备注
email body false String 邮箱地址
phone body false String 手机号码
type body true Int 查询类型
1:邮箱
2:手机号

请求示例：

{
    "type": 1,
    "email": "liqinghua@xlink.cn",
    "phone": "13838383388"
}

返回参数说明

名称 必填 类型 备注
count true Int 符合条件企业总数
list true Array 符合条件企业列表
list.id true String 成员标识
list.name true String 成员名称

返回示例：

{
    "count": 1,
    "list": [{
        "id": "132165654612",
        "name": "物联云平台"
    }]
}

错误码：

错误码 描述
4001001 请求数据字段验证不通过
4001002 请求数据必须字段不可为空
4031001 调用凭证权限被禁止访问
4031003 无效的调用凭证
4031002 需要调用凭证
4041001 接口不存在
5031001 系统错误

5.2.2 通过手机发送验证码

接口描述

企业成员在忘记密码的情况下，可以通过注册手机发送忘记密码专用的验证码，用于重置密码；成员在收到短信验证码后根据短信验证码进行重置密码

请求方式

POST

请求地址

/v2/sms/verifycode

请求头

名称 必填 类型 备注
Content-Type true String application/json

请求参数

名称 位置 必填 类型 备注
phone body true String 手机号码
phone_zone body true String 手机号码区号
corp_id body true String 企业标识
type body true Int 验证码类型
0:默认注册
1:企业忘记密码

请求示例：

{
    "phone": "13838383388",
    "phone_zone": "+86",
    "corp_id": "123456499856",
    "type": 0
}

返回参数说明

名称 必填 类型 备注
无 无 无 无

返回示例：

{
}

错误码：

错误码 描述
4001001 请求数据字段验证不通过
4001002 请求数据必须字段不可为空
4031001 调用凭证权限被禁止访问
4031003 无效的调用凭证
4031002 需要调用凭证
4041001 接口不存在
5031001 系统错误

5.2.3 通过手机验证码修改密码

接口描述

企业成员在忘记密码的情况下，可以通过注册手机发送忘记密码专用的验证码，用于重置密码；成员在收到短信验证码后根据短信验证码进行重置密码

请求方式

POST

请求地址

/v2/corp/password/forgot

请求头

名称 必填 类型 备注
Content-Type true String application/json

请求参数

名称 位置 必填 类型 备注
phone body true String 手机号码
phone_zone body true String 手机号码区号
verifycode body true String 手机验证码
password body true Int 注册人新的密码

请求示例：

{
    "phone": "13838383388",
    "phone_zone":"+86",
    "verifycode":"895665",
    "password":"Test@#$fsafsdc"
}

返回参数说明

名称 必填 类型 备注
无 无 无 无

返回示例：

{
}

错误码：

错误码 描述
4001001 请求数据字段验证不通过
4001002 请求数据必须字段不可为空
4031001 调用凭证权限被禁止访问
4031003 无效的调用凭证
4031002 需要调用凭证
4041001 接口不存在
5031001 系统错误
4041003 成员不存在
4001009 成员状态不合法
没找到需要的文档？
你可以提交工单反馈 或 阅读常见问题
客服工单常见问题